What is react-svg?
The react-svg npm package is a React component that allows you to easily include and manipulate SVG files in your React applications. It provides a simple way to load SVG files and apply various transformations and customizations to them.
What are react-svg's main functionalities?
Basic SVG Loading
This feature allows you to load an SVG file into your React component. The 'src' prop specifies the path to the SVG file.
<ReactSVG src="/path/to/your.svg" />
Customizing SVG with Props
This feature allows you to customize the SVG before it is injected into the DOM. The 'beforeInjection' prop is a function that receives the SVG element and allows you to manipulate it.
<ReactSVG src="/path/to/your.svg" beforeInjection={(svg) => { svg.classList.add('svg-class'); svg.setAttribute('style', 'width: 200px'); }} />
Using SVG as a Component
This feature allows you to use the SVG as a React component, making it easy to include and manage within your React application.
import { ReactSVG } from 'react-svg';
const MyComponent = () => (
<ReactSVG src="/path/to/your.svg" />
);
Handling SVG Load Events
This feature allows you to handle events when the SVG is loaded. The 'onLoad' prop is a function that is called when the SVG has been successfully loaded.
<ReactSVG src="/path/to/your.svg" onLoad={() => console.log('SVG loaded!')} />
Other packages similar to react-svg
react-inlinesvg
react-inlinesvg is a React component that allows you to load and inline SVGs. It provides similar functionality to react-svg but focuses on inlining SVGs directly into the DOM, which can be useful for applying CSS styles directly to the SVG elements.
svgr
SVGR is a tool that transforms SVGs into React components. It allows you to import SVG files as React components, providing a more integrated approach to using SVGs in React applications. Unlike react-svg, SVGR converts SVG files into React components at build time.
react-svg-loader
react-svg-loader is a Webpack loader that allows you to import SVG files as React components. It provides a similar functionality to SVGR but is specifically designed to work with Webpack. This package is useful if you are already using Webpack in your build process.
react-svg
A React component that injects SVG into the DOM.
Background
Let's say you have an SVG available at some URL, and you'd like to inject it into the DOM for various reasons. This module does the heavy lifting for you by delegating the process to SVGInjector, which makes an AJAX request for the SVG and then swaps in the SVG markup inline. The async loaded SVG is also cached, so multiple uses of an SVG only require a single server request.
Basic Usage
import React from 'react'
import { render } from 'react-dom'
import ReactSVG from 'react-svg'
render(<ReactSVG src="svg.svg" />, document.getElementById('root'))
Live Examples
API
Props
src
- The SVG URL.evalScripts
- Optional Run any script blocks found in the SVG. One of 'always'
, 'once'
, or 'never'
. Defaults to 'never'
.fallback
- Optional Fallback to use if an injection error occurs. Can be a string, class component, or function component. Defaults to null
.loading
- Optional Component to use during loading. Can be a string, class component, or function component. Defaults to null
.onInjected
- Optional Function to call after the SVG is injected. If an injection error occurs, this function receives an Error
object as the first parameter. Otherwise, the first parameter is null
and the second parameter is the injected SVG DOM element. Defaults to () => {}
.renumerateIRIElements
- Optional Boolean indicating if SVG IRI addressable elements should be renumerated. Defaults to true
.svgClassName
- Optional Class name to be added to the injected SVG DOM element. Defaults to null
.svgStyle
- Optional Inline styles to be added to the injected SVG DOM element. Defaults to {}
.wrapper
- Optional Wrapper element types. One of 'div'
or 'span'
. Defaults to 'div'
.
Other non-documented properties are applied to the outermost wrapper element.
Example
<ReactSVG
src="svg.svg"
evalScripts="always"
fallback={() => <span>Error!</span>}
loading={() => <span>Loading</span>}
onInjected={(error, svg) => {
if (error) {
console.error(error)
return
}
console.log(svg)
}}
renumerateIRIElements={false}
svgClassName="svg-class-name"
svgStyle={{ width: 200 }}
wrapper="span"
className="wrapper-class-name"
onClick={() => {
console.log('wrapper onClick')
}}
/>
Installation
$ npm install react-svg
There are also UMD builds available via unpkg:
For the non-minified development version, make sure you have already included:
For the minified production version, make sure you have already included:
Credits
Thanks to the author(s) of the original SVGInjector, without which none of this would have been possible :clap:
License
MIT